/**
 * Collaborative Story Development Web Application (CSDApp) 
 * Copyright Anton Strack 2014
 *
 * This file is part of Collaborative Story Development Application (CSDApp).
 *
 * CSDApp is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or any later version.
 *
 * CSDApp is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * CSDApp. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package csdwa;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * This class provides database access to the specific resource model. It
 * provides CRUD database functionality and it stores it's results as a list.
 * Additionally, through it's methods, it provides access to determine the table
 * name, and query markers that are set for the particular DAO and thus allows
 * other code a means of interacting with this DAO to execute more advanced
 * queries.
 *
 * @author Anton Strack
 */
public class CharacterDao extends PostDao implements CsdwaDao<Character> {

    private List<Character> beans;

    public CharacterDao(Connection conn) {
        super(conn);
        this.beans = new ArrayList<Character>();
        this.restoreQueryMarkers();
    }

    /**
     * Select all the beans from the bean table
     *
     * @return the row count indicating if 0 or more beans were retrieved from
     * the database.
     */
    @Override
    public int selectBeans() {
        this.setMarker(QueryMarker.CORE_CONDITIONS, "actor.StateID <> " + InfoAggregator.getInstance().getStateTypeId("priorversion"));
        int result = super.selectBeans();
        return result;
    }

    /**
     * Select a single bean by it's id.
     *
     * @param id the id number of the bean to select.
     * @return 1 or 0, indicating a bean was retrieved or not.
     */
    @Override
    public int selectBeanById(int id) {
        this.setMarker(QueryMarker.CORE_CONDITIONS, "actor.ID = ?");
        int result = super.selectBeanById(id);
        return result;
    }

    /**
     * Clear the bean list so it doesn't contain any beans.
     */
    @Override
    public void clearDaoBeans() {
        this.beans.clear();
    }

    /**
     * This method builds the parent chain in the dao's bean list. To ensure the
     * bean list only contains the child parent chain, clearDaoBeans() should be
     * called directly before this method.
     *
     * @param parentId the parentId to start the chain with.
     */
    public void makeParentChain(int parentId) {
        int result;// = 0;
        if (parentId > 0) {
            result = this.selectBeanById(parentId);
            if (result > 0) {
                this.makeParentChain(this.getBeanById(parentId).getParentId());
            }
        }
    }

    /**
     * Get the bean stored in the dao by it's primary id.
     *
     * @param id the id of the bean to select.
     * @return the bean if it exists in the dao or null if it doesn't
     */
    @Override
    public Character getBeanById(int id) {
        Character bean = null;
        if (this.beans.isEmpty() == false) {
            for (Character b : this.beans) {
                if (b.getId() == id) {
                    bean = b;
                    break;
                }
            }
        }
        return bean;
    }

    /**
     * Save a bean to the database
     *
     * @param bean the bean to insert. The bean id is not required and won't be
     * used. All other bean values are required.
     * @return the auto-generated id key for the new bean row or 0 on failure.
     */
    @Override
    public int insertBean(Character bean) {
        int result = 0;
        ResultSet rs;
        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_COLUMNS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.usingQueryMarkers.add(QueryMarker.INSERT_VALUES);
        /*
         * HSQLDB cannot properly handle insert statements that have table identifiesr in the form of table.columnName so we need to remove the table name for inserts.
         */
        this.queryMarkers.put(QueryMarker.CORE_COLUMNS, this.prepareInsertColumns(this.getMarker(QueryMarker.CORE_COLUMNS)));
        try {
            this.ps = this.getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, INSERT_QUERY), Statement.RETURN_GENERATED_KEYS);
            this.ps.setNull(1, java.sql.Types.NULL);
            this.ps.setInt(2, bean.getUpdatedById());
            this.ps.setInt(3, bean.getCreatedById());
            this.ps.setInt(4, bean.getStateId());
            this.ps.setInt(5, bean.getResourceTypeId());
            this.ps.setInt(6, bean.getParentId());
            this.ps.setTimestamp(7, bean.getUpdatedDate());
            this.ps.setTimestamp(8, bean.getCreatedDate());
            this.ps.setString(9, bean.getName());
            this.ps.setString(10, bean.getDescription());
            this.ps.setString(11, bean.getBody());
            result = this.ps.executeUpdate();
            rs = ps.getGeneratedKeys();
            if (result != 0 && rs.next()) {
                result = rs.getInt(1); // get the auto-generated key from the successful insert operation.
            }
        } catch (SQLException ex) {
            Logger.getLogger(CharacterDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Update a bean in the database as well as the bean in the dao's beans map.
     *
     * @param bean the bean to update.
     * @return 1 or 0 indicating if the bean was updated or not.
     */
    @Override
    public int updateBean(Character bean) {
        int result = 0;

        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_CONDITIONS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.usingQueryMarkers.add(QueryMarker.UPDATE_COLUMNS_VALUES);

        String[] cols = this.splitStringByCommas(this.COLUMNS_TO_UPDATE);

        this.setMarker(QueryMarker.UPDATE_COLUMNS_VALUES, this.prepareUpdateColumns(cols));
        this.setMarker(QueryMarker.CORE_CONDITIONS, "ID = ?");

        try {
            this.ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, UPDATE_QUERY));
            int index = 1;
            for (String col : cols) {
                if ("name".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getName());
                    index++;
                } else if ("body".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getBody());
                    index++;
                } else if ("description".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getDescription());
                    index++;
                } else if ("parentId".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getParentId());
                    index++;
                } else if ("createdById".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getCreatedById());
                    index++;
                } else if ("updatedById".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getUpdatedById());
                    index++;
                } else if ("stateId".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getStateId());
                    index++;
                } else if ("resourceTypeId".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getResourceTypeId());
                    index++;
                } else if ("updatedDate".equalsIgnoreCase(col)) {
                    this.ps.setTimestamp(index, bean.getUpdatedDate());
                    index++;
                } else if ("createdDate".equalsIgnoreCase(col)) {
                    this.ps.setTimestamp(index, bean.getCreatedDate());
                    index++;
                }
            }
            this.ps.setInt(index, bean.getId()); // where column condition
            result = this.ps.executeUpdate();
        } catch (SQLException ex) {
            Logger.getLogger(ResourceTypeDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Deletes the bean from the database
     *
     * @param bean the bean to delete
     * @return 1 or 0 indicating if the bean was deleted or not.
     */
    @Override
    public int deleteBean(Character bean) {
        int result = 0;
        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_CONDITIONS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.setMarker(QueryMarker.CORE_CONDITIONS, "ID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, DELETE_QUERY));
            this.ps.setInt(1, bean.getId());
            result = this.ps.executeUpdate();
        } catch (SQLException ex) {
            Logger.getLogger(CharacterDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Reset the query markers to their default values for the dao.
     */
    @Override
    public void restoreQueryMarkers() {
        this.setMarker(QueryMarker.CORE_TABLE, "actor");// character seemed to cause problems with database when used as a column name
        this.setMarker(QueryMarker.CORE_COLUMNS, "actor.ID, actor.UpdatedByID, actor.CreatedByID, actor.StateID, actor.ResourceTypeID, actor.ParentID, actor.UpdatedDate, actor.CreatedDate, actor.Name, actor.Description, actor.Body");
        this.setMarker(QueryMarker.CORE_CONDITIONS, "actor.ID = ?");
        this.setMarker(QueryMarker.ORDER_BY_COLUMN, "actor.UpdatedDate");
        this.setMarker(QueryMarker.ORDER_BY_MODE, "DESC");
        this.setMarker(QueryMarker.LIMIT, "");
        this.setMarker(QueryMarker.INSERT_VALUES, "?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?");
        this.setMarker(QueryMarker.UPDATE_COLUMNS_VALUES, "");
        this.setMarker(QueryMarker.PRIMARY_KEY, "ID");
        // special type of derived values
        this.setMarker(QueryMarker.RELATED_COLUMNS, ", upUser.Username AS UpdatedByName, crUser.Username AS CreatedByName, state.name AS StateName, resourcetype.name as ResourceTypeName");
        this.setMarker(QueryMarker.RELATED_CONDITIONS, " AND actor.ResourceTypeID = resourcetype.ID AND actor.UpdatedByID = upUser.ID AND actor.CreatedByID = crUser.ID AND actor.StateID = state.ID");
        this.setMarker(QueryMarker.RELATED_TABLES, ", useraccount AS upUser, useraccount AS crUser, state, resourcetype");
        this.COLUMNS_TO_UPDATE = "UpdatedByID, StateID, ParentID, UpdatedDate, Name, Description, Body";
    }

    /**
     * Execute the select query and place the results in beans list.
     *
     * @param ps the fully prepared PreparedStatement
     * @return the row count from the select statement
     */
    @Override
    protected int executeSelectQuery(PreparedStatement ps) {
        int result = 0;
        ResultSet rs;
        try {
            rs = ps.executeQuery();
            while (rs.next()) {
                Character bean = ResourceFactory.makeCharacter();
                bean.setId(rs.getInt("actor.ID"));
                bean.setUpdatedById(rs.getInt("actor.UpdatedByID"));
                bean.setCreatedById(rs.getInt("actor.CreatedByID"));
                bean.setStateId(rs.getInt("actor.StateID"));
                bean.setResourceTypeId(rs.getInt("actor.ResourceTypeID"));
                bean.setParentId(rs.getInt("actor.ParentID"));
                bean.setUpdatedDate(rs.getTimestamp("actor.UpdatedDate"));
                bean.setCreatedDate(rs.getTimestamp("actor.CreatedDate"));
                bean.setName(rs.getString("actor.Name"));
                bean.setDescription(rs.getString("actor.Description"));
                bean.setBody(rs.getString("actor.Body"));
                if (this.USE_RELATED_MARKERS == true) {
                    bean.setDerivedValue("UpdatedByName", rs.getString("UpdatedByName"));
                    bean.setDerivedValue("CreatedByName", rs.getString("CreatedByName"));
                    bean.setDerivedValue("StateName", rs.getString("StateName"));
                    bean.setDerivedValue("ResourceTypeName", rs.getString("ResourceTypeName"));
                }
                this.processDerivedValues(bean, rs);
                this.beans.add(bean);
                result++;
            }
        } catch (SQLException ex) {
            Logger.getLogger(ActionDao.class.getName()).log(Level.SEVERE, null, ex);
        }


        return result;
    }

    /**
     * Get a list of beans
     *
     * @return a list of bean objects
     */
    @Override
    public List<Character> getBeans() {
        return new ArrayList<Character>(this.beans);
    }

    /**
     * Get a single bean.
     *
     * @return a single bean in the bean dao.
     */
    @Override
    public Character getBean() {
        if (this.beans.isEmpty()) {
            return null;
        }
        return this.beans.get(0);
    }

    /**
     * Add a bean in the dao's bean list.
     *
     * @param bean the bean to add or update
     */
    @Override
    public void addBeanToDao(Character bean) {
        this.beans.add(bean);
    }
}
